home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / mask < prev    next >
Text File  |  2001-03-21  |  2KB  |  54 lines
  1. Synopsis:
  2.    $mask(<type> <address>)
  3.  
  4. Technical:
  5.    This function returns <address> in a wildcard mask according to the type
  6.    specified by <type>. The mask types are defined in the following table:
  7.    
  8.     <type>     <address> has a hostname       <address> has an ip
  9.   -------------------------------------------------------------------
  10.       0            *!u@h.d                        *!u@d.h
  11.       1            *!*u@h.d                       *!*u@d.h
  12.       2            *!*@h.d                        *!*@d.h
  13.       3            *!*u@*.d                       *!*u@d.*
  14.       4            *!*@*.d                        *!*@d.*
  15.       5            n!u@h.d                        n!u@d.h
  16.       6            n!*u@h.d                       n!*u@d.h
  17.       7            n!*@h.d                        n!*@d.h
  18.       8            n!*u@*.d                       n!*u@d.*
  19.       9            n!*@*.d                        n!*@d.*
  20.       10           *!*@h.d                        *!*@d.*
  21.       11           *!*u@h.d                       *!*u@d.*
  22.       12           n!*@h.d                        n!*@d.*
  23.       13           n!*u@h.d                       n!*u@d.*
  24.  
  25.    where n=nick, u=user, h=host, and d=domain
  26.  
  27.    With the following modifications:  In the ``local'' portion of
  28.    the hostname, all sequence of numbers are substituted with a
  29.    single '*'.  In the username, leading ~'s are also substituted
  30.    with a single '*'.
  31.  
  32. Returns:
  33.    <address> in a wildcard mask according to <type>
  34.  
  35. Examples:
  36.    $mask(3 foo!bar@long.host.blah.com)
  37.       returns:
  38.    *!*bar@*.blah.com
  39.  
  40.    $mask(10 nick!user@ppp-147-0-52-129.frobitz.com)
  41.       returns:
  42.    *!*@ppp-*-*-*-*.frobitz.com
  43.  
  44. See also:
  45.   uhc(6); deuhc(6)
  46.  
  47. Other Notes:
  48.    This function strips all tildes ('~') from the left of the username. For
  49.    script writers, this means that in mask types 0 and 5, the function is
  50.    *NOT* guaranteed to produce a mask matching the given address. If a script
  51.    is to use these types, they should expect tildes to be stripped and be able
  52.    to act accordingly.
  53.  
  54.